THE

APPENDIX 1 - ENVIRONMENT VARIABLES


THE uses the following environment variables:

THE_HOME_DIR
the directory in which THE looks for its help file(s) and macro(s)

THE_HELP_FILE
the fully qualified file name containing help information.

THE_PROFILE_FILE
the fully qualified file name for the default profile file.

THE_MACRO_PATH
a list of all directories in which THE is to look for macro files.

The following defines how these environment variables are used under UNIX.

If no environment variable; THE_HOME_DIR, is set prior to starting THE, THE uses /usr/local/THE/ as the default value for ${THE_HOME_DIR} if running under Unix. This can be changed when running the configure script. See the file INSTALL for further details.

The default value of THE_HELP_FILE is ${THE_HOME_DIR}${TERM}.hlp eg. with no environment variables set and $TERM set to vt220, the help file to be looked for will be /usr/local/THE/vt220.hlp. If THE_HOME_DIR environment variable was set to /usr/opt/etc or changed in the.c, the help file will be /usr/opt/etc/vt220.hlp. If no $TERM environment variable is set, "default" is used.

The name of the default profile file is $HOME/.therc.

The default value of THE_MACRO_PATH is ${THE_HOME_DIR}:. THE will look for a macro file first in ${THE_HOME_DIR} and then in the current directory. So with no environment variables set, THE looks for macros in $(THE_HOME_DIR} first and if no file exists in that directory, THE will look in the current directory. If the file does not exist in either of these places, an error message will be displayed. The format of THE_MACRO_PATH is dir1:dir2:dir3 Each directory is seperated by colons. By default, up to 20 directories may be specified. This can be changed in the.h.

The following defines how these environment variables are used under DOS and OS/2.

By default THE_HOME_DIR is set to the directory from which THE was invoked. Assuming THE.EXE resides in d:\tools, THE_HOME_DIR will equate to d:\tools\.

The default value of THE_HELP_FILE is ${THE_HOME_DIR}dos.hlp for DOS and ${THE_HOME_DIR}os2.hlp for OS/2.

The name of the default profile file is ${THE_HOME_DIR}profile.the.

The default value of THE_MACRO_PATH is ${THE_HOME_DIR};. THE will look for a macro file first in THE_HOME_DIR and then in the current directory. So with no environment variables set, THE first looks for macros in the directory from which THE was invoked and then in the current directory. If the file does not exist in either directory, an error message is displayed. The format of THE_MACRO_PATH is dir1;dir2;dir3 Each directory is seperated by semi-colons. By default up to 20 directories may be specified. This can be changed in the.h.


The Hessling Editor is Copyright © Mark Hessling, 1990-1996 <M.Hessling@qut.edu.au>
Generated on: 26 May 1996

Return to Table of Contents